Foxit PDF SDK
FoxitPDFSDKPython2.ParagraphEditing类 参考
类 FoxitPDFSDKPython2.ParagraphEditing 继承关系图:
FoxitPDFSDKPython2.Base

Public 成员函数

def ParagraphEditing (other)
 构造函数,使用另一个段落编辑对象。 更多...
 
def Activate ()
 激活段落编辑。 更多...
 
def CanCopy ()
 检查是否可以复制文本。 更多...
 
def CanCut ()
 检查是否可以剪切文本。 更多...
 
def CanDelete ()
 检查是否可以删除文本。 更多...
 
def CanDeselectAll ()
 检查是否可以取消选择所有文本。 更多...
 
def CanPaste ()
 检查是否可以粘贴文本。 更多...
 
def CanSelectAll ()
 检查是否可以全选文本。 更多...
 
def CopySelected ()
 复制选中的文本。 更多...
 
def CutSelected ()
 剪切选中的文本。 更多...
 
def Deactivate ()
 停用段落编辑。 更多...
 
def Dedent ()
 减少文本缩进。 更多...
 
def DeleteSelected ()
 删除选中的文本。 更多...
 
def DeselectAll ()
 取消选择所有文本。 更多...
 
def ExitEditing (is_end_directly)
 退出段落编辑。 更多...
 
def Indent ()
 增加文本缩进。 更多...
 
def InsertText (text)
 在页面中插入文本时调用此函数。 更多...
 
def IsEmpty ()
 检查当前对象是否为空。 更多...
 
def OnChar (char_code)
 输入字符代码时调用此函数。 更多...
 
def OnKeyDown (key_code)
 键盘按键按下时调用此函数。 更多...
 
def OnKeyUp (key_code)
 键盘按键抬起时调用此函数。 更多...
 
def OnLButtonDoubleClick (page_index, point)
 鼠标左键双击时调用此函数。 更多...
 
def OnLButtonDown (page_index, point)
 鼠标左键按下时调用此函数。 更多...
 
def OnLButtonUp (page_index, point)
 鼠标左键抬起时调用此函数。 更多...
 
def OnMouseMove (page_index, point)
 鼠标移动时调用此函数。 更多...
 
def OnMouseWheel (page_index, point, delta)
 鼠标滚轮滚动时调用此函数。 更多...
 
def PasteSelected ()
 粘贴复制的文本。 更多...
 
def Render (page_index_array, renderer)
 在渲染器上绘制当前段落编辑操作状态。 更多...
 
def SelectAll ()
 全选文本。 更多...
 
def SetAlignment (alignment)
 为文本设置文本对齐方式。 更多...
 
def SetBold (is_bold)
 为文本设置粗体状态。 更多...
 
def SetBulletedList (bullet_type)
 为文本设置项目符号列表。 更多...
 
def SetCharHorizontalScale (scale)
 为文本设置字符水平缩放。 更多...
 
def SetCharSpace (char_space)
 为文本设置字符间距。 更多...
 
def SetFontName (font_name)
 为文本设置字体名称。 更多...
 
def SetFontSize (font_size)
 为文本设置字体大小。 更多...
 
def SetItalic (is_italic)
 为文本设置斜体状态。 更多...
 
def SetLineSpace (line_space)
 为文本设置行间距。 更多...
 
def SetNumberedList (numbering_type)
 为文本设置编号列表的外观。 更多...
 
def SetParagraphSpacing (paragraph_space)
 为文本设置段落间距。 更多...
 
def SetStrikethrough (is_striketrough)
 为文本设置删除线样式。 更多...
 
def SetSubscript (is_subscript)
 为文本设置下标属性。 更多...
 
def SetSuperscript (is_superscript)
 为文本设置上标属性。 更多...
 
def SetTextColor (text_color)
 为文本设置文本颜色。 更多...
 
def SetUnderline (is_underline)
 为文本设置下划线。 更多...
 
def StartEditing (page_index, start_point, end_point)
 开始段落编辑。 更多...
 

静态 Public 属性

 e_BulletTypeBlackDiamondMinusWhite = _fsdk.ParagraphEditing_e_BulletTypeBlackDiamondMinusWhite
 项目符号类型:黑菱形减去白色。
 
 e_BulletTypeCheck = _fsdk.ParagraphEditing_e_BulletTypeCheck
 项目符号类型:对勾。
 
 e_BulletTypeDiagonalUpRightArrow = _fsdk.ParagraphEditing_e_BulletTypeDiagonalUpRightArrow
 项目符号类型:右上对角箭头。
 
 e_BulletTypeInverseTangentCircle = _fsdk.ParagraphEditing_e_BulletTypeInverseTangentCircle
 项目符号类型:反切圆。
 
 e_BulletTypeNone = _fsdk.ParagraphEditing_e_BulletTypeNone
 项目符号类型:无。
 
 e_BulletTypeRightArrow = _fsdk.ParagraphEditing_e_BulletTypeRightArrow
 项目符号类型:右箭头(上白下黑)。
 
 e_BulletTypeSolidCircle = _fsdk.ParagraphEditing_e_BulletTypeSolidCircle
 项目符号类型:实心圆。
 
 e_BulletTypeSolidDiamond = _fsdk.ParagraphEditing_e_BulletTypeSolidDiamond
 项目符号类型:实心菱形。
 
 e_BulletTypeSolidRectangle = _fsdk.ParagraphEditing_e_BulletTypeSolidRectangle
 项目符号类型:实心矩形。
 
 e_NumberingTypeDecimalDot = _fsdk.ParagraphEditing_e_NumberingTypeDecimalDot
 编号类型:1. 2. 3.
 
 e_NumberingTypeDecimalRParen = _fsdk.ParagraphEditing_e_NumberingTypeDecimalRParen
 编号类型:1) 2) 3)
 
 e_NumberingTypeLowerLatinDot = _fsdk.ParagraphEditing_e_NumberingTypeLowerLatinDot
 编号类型:a. b. c.
 
 e_NumberingTypeLowerLatinRParen = _fsdk.ParagraphEditing_e_NumberingTypeLowerLatinRParen
 编号类型:a) b) c)
 
 e_NumberingTypeNone = _fsdk.ParagraphEditing_e_NumberingTypeNone
 编号类型:无。
 
 e_NumberingTypeUpperLatinDot = _fsdk.ParagraphEditing_e_NumberingTypeUpperLatinDot
 编号类型:A. B. C.
 

详细描述

此类表示段落编辑操作。 在使用段落编辑功能的任何方法之前,请确保已调用函数 FoxitPDFSDKPython2.ParagraphEditing.Activate 。 不需要使用任何段落编辑功能时,请调用函数 FoxitPDFSDKPython2.ParagraphEditing.Deactivate 来停用。

构造及析构函数说明

◆ ParagraphEditing()

def FoxitPDFSDKPython2.ParagraphEditing.ParagraphEditing (   other)

构造函数,使用另一个段落编辑对象。

参数
[in]other另一个段落编辑对象。

成员函数说明

◆ Activate()

def FoxitPDFSDKPython2.ParagraphEditing.Activate ( )

激活段落编辑。

返回
true 表示成功,false 表示失败。

◆ CanCopy()

def FoxitPDFSDKPython2.ParagraphEditing.CanCopy ( )

检查是否可以复制文本。

返回
true 表示当前选中的文本对象可以被复制,false 表示不可以。

◆ CanCut()

def FoxitPDFSDKPython2.ParagraphEditing.CanCut ( )

检查是否可以剪切文本。

返回
true 表示当前选中的文本可以被剪切,false 表示不可以。

◆ CanDelete()

def FoxitPDFSDKPython2.ParagraphEditing.CanDelete ( )

检查是否可以删除文本。

返回
true 表示当前选中的文本可以被删除,false 表示不可以。

◆ CanDeselectAll()

def FoxitPDFSDKPython2.ParagraphEditing.CanDeselectAll ( )

检查是否可以取消选择所有文本。

返回
true 表示当前选中的文本可以被取消选择,false 表示不可以。

◆ CanPaste()

def FoxitPDFSDKPython2.ParagraphEditing.CanPaste ( )

检查是否可以粘贴文本。

返回
true 表示当前选中的文本可以被粘贴,false 表示不可以。

◆ CanSelectAll()

def FoxitPDFSDKPython2.ParagraphEditing.CanSelectAll ( )

检查是否可以全选文本。

返回
true 表示当前所有文本可以被选择,false 表示不可以。

◆ CopySelected()

def FoxitPDFSDKPython2.ParagraphEditing.CopySelected ( )

复制选中的文本。

返回
true 表示成功,false 表示失败。

◆ CutSelected()

def FoxitPDFSDKPython2.ParagraphEditing.CutSelected ( )

剪切选中的文本。

返回
true 表示成功,false 表示失败。

◆ Deactivate()

def FoxitPDFSDKPython2.ParagraphEditing.Deactivate ( )

停用段落编辑。

返回
true 表示成功,false 表示失败。

◆ Dedent()

def FoxitPDFSDKPython2.ParagraphEditing.Dedent ( )

减少文本缩进。

返回
无。

◆ DeleteSelected()

def FoxitPDFSDKPython2.ParagraphEditing.DeleteSelected ( )

删除选中的文本。

返回
true 表示成功,false 表示失败。

◆ DeselectAll()

def FoxitPDFSDKPython2.ParagraphEditing.DeselectAll ( )

取消选择所有文本。

返回
true 表示成功,false 表示失败。

◆ ExitEditing()

def FoxitPDFSDKPython2.ParagraphEditing.ExitEditing (   is_end_directly)

退出段落编辑。

参数
[in]is_end_directly是否直接结束编辑。
返回
无。

◆ Indent()

def FoxitPDFSDKPython2.ParagraphEditing.Indent ( )

增加文本缩进。

返回
无。

◆ InsertText()

def FoxitPDFSDKPython2.ParagraphEditing.InsertText (   text)

在页面中插入文本时调用此函数。

参数
[in]text要插入的文本。
返回
true 表示成功,false 表示失败。

◆ IsEmpty()

def FoxitPDFSDKPython2.ParagraphEditing.IsEmpty ( )

检查当前对象是否为空。

当当前对象为空时,意味着当前对象无用。

返回
true 表示当前对象为空,false 表示不为空。

◆ OnChar()

def FoxitPDFSDKPython2.ParagraphEditing.OnChar (   char_code)

输入字符代码时调用此函数。

参数
[in]char_code字符代码,采用 UTF16-LE 编码。
返回
true 表示成功,false 表示失败。

◆ OnKeyDown()

def FoxitPDFSDKPython2.ParagraphEditing.OnKeyDown (   key_code)

键盘按键按下时调用此函数。

参数
[in]key_code键代码。请参考从 FoxitPDFSDKPython2.Filler.e_VkeyUnknown 开始的值, 应该是这些值中的一个。
返回
true 表示成功,false 表示失败。

◆ OnKeyUp()

def FoxitPDFSDKPython2.ParagraphEditing.OnKeyUp (   key_code)

键盘按键抬起时调用此函数。

参数
[in]key_code键代码。请参考从 FoxitPDFSDKPython2.Filler.e_VkeyUnknown 开始的值, 应该是这些值中的一个。
返回
true 表示成功,false 表示失败。

◆ OnLButtonDoubleClick()

def FoxitPDFSDKPython2.ParagraphEditing.OnLButtonDoubleClick (   page_index,
  point 
)

鼠标左键双击时调用此函数。

参数
[in]page_index页面索引。
[in]point鼠标左键在页面中双击的点,以设备坐标系表示。
返回
true 表示成功,false 表示失败。

◆ OnLButtonDown()

def FoxitPDFSDKPython2.ParagraphEditing.OnLButtonDown (   page_index,
  point 
)

鼠标左键按下时调用此函数。

参数
[in]page_index页面索引。
[in]point鼠标左键在页面中按下的点,以设备坐标系表示。
返回
true 表示成功,false 表示失败。

◆ OnLButtonUp()

def FoxitPDFSDKPython2.ParagraphEditing.OnLButtonUp (   page_index,
  point 
)

鼠标左键抬起时调用此函数。

参数
[in]page_index页面索引。
[in]point鼠标左键在页面中抬起的点,以设备坐标系表示。
返回
true 表示成功,false 表示失败。

◆ OnMouseMove()

def FoxitPDFSDKPython2.ParagraphEditing.OnMouseMove (   page_index,
  point 
)

鼠标移动时调用此函数。

参数
[in]page_index页面索引。
[in]point鼠标在页面中的点,以设备坐标系表示。
返回
true 表示成功,false 表示失败。

◆ OnMouseWheel()

def FoxitPDFSDKPython2.ParagraphEditing.OnMouseWheel (   page_index,
  point,
  delta 
)

鼠标滚轮滚动时调用此函数。

参数
[in]page_index页面索引。
[in]point鼠标在页面中的点,以设备坐标系表示。
[in]delta指示鼠标滚轮移动的量。正值表示向前移动, 负值表示向后移动。
返回
true 表示成功,false 表示失败。

◆ PasteSelected()

def FoxitPDFSDKPython2.ParagraphEditing.PasteSelected ( )

粘贴复制的文本。

返回
true 表示成功,false 表示失败。

◆ Render()

def FoxitPDFSDKPython2.ParagraphEditing.Render (   page_index_array,
  renderer 
)

在渲染器上绘制当前段落编辑操作状态。

渲染过程中使用的矩阵由 FoxitPDFSDKPython2.ParagraphEditingProviderCallback.GetRenderMatrix 返回。

参数
[in]page_index_array要渲染的页面索引数组。
[in]renderer用于渲染的有效渲染器对象。
返回
true 表示成功,false 表示失败。

◆ SelectAll()

def FoxitPDFSDKPython2.ParagraphEditing.SelectAll ( )

全选文本。

返回
true 表示成功,false 表示失败。

◆ SetAlignment()

def FoxitPDFSDKPython2.ParagraphEditing.SetAlignment (   alignment)

为文本设置文本对齐方式。

参数
[in]alignment对齐值。请参考从 FoxitPDFSDKPython2.e_AlignmentLeft 开始的值, 应该是这些值中的一个。
返回
无。

◆ SetBold()

def FoxitPDFSDKPython2.ParagraphEditing.SetBold (   is_bold)

为文本设置粗体状态。

参数
[in]is_bold是否将选中的文本设置为粗体。true 表示当前选中的文本将被设置为粗体,false 表示不设置。
返回
无。

◆ SetBulletedList()

def FoxitPDFSDKPython2.ParagraphEditing.SetBulletedList (   bullet_type)

为文本设置项目符号列表。

在设置项目符号列表之前,请确保已安装 "wingding.ttf" 字体。

参数
[in]bullet_type项目符号类型。请参考从 开始的值, 应该是这些值中的一个。 无。

◆ SetCharHorizontalScale()

def FoxitPDFSDKPython2.ParagraphEditing.SetCharHorizontalScale (   scale)

为文本设置字符水平缩放。

参数
[in]scale缩放比例。应该大于 0。
返回
无。

◆ SetCharSpace()

def FoxitPDFSDKPython2.ParagraphEditing.SetCharSpace (   char_space)

为文本设置字符间距。

参数
[in]char_space字符间距(单位为 1/72 英寸)。
返回
无。

◆ SetFontName()

def FoxitPDFSDKPython2.ParagraphEditing.SetFontName (   font_name)

为文本设置字体名称。

参数
[in]font_name字体名称。
返回
无。

◆ SetFontSize()

def FoxitPDFSDKPython2.ParagraphEditing.SetFontSize (   font_size)

为文本设置字体大小。

参数
[in]font_size字体大小。
返回
无。

◆ SetItalic()

def FoxitPDFSDKPython2.ParagraphEditing.SetItalic (   is_italic)

为文本设置斜体状态。

参数
[in]is_italic是否将选中的文本设置为斜体。true 表示当前选中的文本将被设置为斜体,false 表示不设置。
返回
无。

◆ SetLineSpace()

def FoxitPDFSDKPython2.ParagraphEditing.SetLineSpace (   line_space)

为文本设置行间距。

参数
[in]line_space行间距(单位为 1/72 英寸)。
返回
无。

◆ SetNumberedList()

def FoxitPDFSDKPython2.ParagraphEditing.SetNumberedList (   numbering_type)

为文本设置编号列表的外观。

参数
[in]numbering_type编号类型。请参考从 开始的值, 应该是这些值中的一个。 无。

◆ SetParagraphSpacing()

def FoxitPDFSDKPython2.ParagraphEditing.SetParagraphSpacing (   paragraph_space)

为文本设置段落间距。

参数
[in]paragraph_space段落间距。
返回
无。

◆ SetStrikethrough()

def FoxitPDFSDKPython2.ParagraphEditing.SetStrikethrough (   is_striketrough)

为文本设置删除线样式。

参数
[in]is_striketroughtrue 表示设置删除线样式,false 表示不设置。
返回
无。

◆ SetSubscript()

def FoxitPDFSDKPython2.ParagraphEditing.SetSubscript (   is_subscript)

为文本设置下标属性。

返回
无。

◆ SetSuperscript()

def FoxitPDFSDKPython2.ParagraphEditing.SetSuperscript (   is_superscript)

为文本设置上标属性。

返回
无。

◆ SetTextColor()

def FoxitPDFSDKPython2.ParagraphEditing.SetTextColor (   text_color)

为文本设置文本颜色。

参数
[in]text_color文本颜色。
返回
无。

◆ SetUnderline()

def FoxitPDFSDKPython2.ParagraphEditing.SetUnderline (   is_underline)

为文本设置下划线。

参数
[in]is_underlinetrue 表示给文本加下划线,false 表示不加。
返回
无。

◆ StartEditing()

def FoxitPDFSDKPython2.ParagraphEditing.StartEditing (   page_index,
  start_point,
  end_point 
)

开始段落编辑。

参数
[in]page_index页面索引。
[in]start_point在页面上开始编辑的点,以设备坐标系表示。
[in]end_point在页面上结束编辑的点,以设备坐标系表示。
返回
无。